<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: D:/Projects/MiXiM/extsrc/mixim/src/base/modules/BaseWorldUtility.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00276.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">BaseWorldUtility.h</div>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode:c++ -*- ********************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> * file:        BaseWorldUtility.h</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * author:      Tom Parker</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * copyright:   (C) 2007 Parallel and Distributed Systems Group (PDS) at</span>
<a name="l00007"></a>00007 <span class="comment"> *              Technische Universiteit Delft, The Netherlands.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> *              This program is free software; you can redistribute it</span>
<a name="l00010"></a>00010 <span class="comment"> *              and/or modify it under the terms of the GNU General Public</span>
<a name="l00011"></a>00011 <span class="comment"> *              License as published by the Free Software Foundation; either</span>
<a name="l00012"></a>00012 <span class="comment"> *              version 2 of the License, or (at your option) any later</span>
<a name="l00013"></a>00013 <span class="comment"> *              version.</span>
<a name="l00014"></a>00014 <span class="comment"> *              For further information see file COPYING</span>
<a name="l00015"></a>00015 <span class="comment"> *              in the top level directory</span>
<a name="l00016"></a>00016 <span class="comment"> ***************************************************************************</span>
<a name="l00017"></a>00017 <span class="comment"> * description: basic world utility class</span>
<a name="l00018"></a>00018 <span class="comment"> *              provides world-required values</span>
<a name="l00019"></a>00019 <span class="comment"> **************************************************************************/</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef BASE_WORLD_UTIL_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define BASE_WORLD_UTIL_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &quot;MiXiMDefs.h&quot;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &quot;Coord.h&quot;</span>
<a name="l00026"></a>00026 
<a name="l00032"></a><a class="code" href="a00030.html">00032</a> <span class="keyword">class </span>MIXIM_API <a class="code" href="a00030.html" title="Provides information and utility methods for the whole simulation.">BaseWorldUtility</a> : <span class="keyword">public</span> cSimpleModule
<a name="l00033"></a>00033 {
<a name="l00034"></a>00034 <span class="keyword">protected</span>:
<a name="l00042"></a><a class="code" href="a00030.html#a74ba640d810a03334770d1f150fe1da4">00042</a>     <a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a> <a class="code" href="a00030.html#a74ba640d810a03334770d1f150fe1da4" title="Size of the area the nodes are in (in meters)">playgroundSize</a>;
<a name="l00043"></a>00043 
<a name="l00045"></a><a class="code" href="a00030.html#aa906ac76b1c5b51f6743104b532ed4f3">00045</a>     <span class="keywordtype">bool</span> <a class="code" href="a00030.html#aa906ac76b1c5b51f6743104b532ed4f3" title="Should the playground be treatend as a torus?">useTorusFlag</a>;
<a name="l00046"></a>00046 
<a name="l00048"></a><a class="code" href="a00030.html#abc092a88c21ecc008a7a32bc311201e7">00048</a>     <span class="keywordtype">bool</span> <a class="code" href="a00030.html#abc092a88c21ecc008a7a32bc311201e7" title="Should the world be 2-dimensional?">use2DFlag</a>;
<a name="l00049"></a>00049 
<a name="l00051"></a><a class="code" href="a00030.html#a490427de9d083bd510a4370002f70716">00051</a>     <span class="keywordtype">long</span> <a class="code" href="a00030.html#a490427de9d083bd510a4370002f70716" title="Provides a unique number for AirFrames per simulation.">airFrameId</a>;
<a name="l00052"></a>00052 
<a name="l00054"></a><a class="code" href="a00030.html#a3c5b996451b88c37022a191668d715a1">00054</a>     <span class="keywordtype">bool</span> <a class="code" href="a00030.html#a3c5b996451b88c37022a191668d715a1" title="Stores if members are already initialized.">isInitialized</a>;
<a name="l00055"></a>00055 
<a name="l00056"></a>00056 <span class="keyword">public</span>:
<a name="l00058"></a><a class="code" href="a00030.html#a84d040f815027b3098451b02733ac63d">00058</a>     <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="a00030.html#a84d040f815027b3098451b02733ac63d" title="Speed of light in meters per second.">speedOfLight</a>;
<a name="l00059"></a>00059 
<a name="l00060"></a>00060 <span class="keyword">protected</span>:
<a name="l00067"></a>00067     <span class="keyword">virtual</span> <span class="keywordtype">void</span> initializeIfNecessary();
<a name="l00068"></a>00068 
<a name="l00069"></a>00069 <span class="keyword">public</span>:
<a name="l00070"></a>00070     <a class="code" href="a00030.html" title="Provides information and utility methods for the whole simulation.">BaseWorldUtility</a>();
<a name="l00071"></a>00071 
<a name="l00072"></a>00072     <span class="keyword">virtual</span> <span class="keywordtype">void</span> initialize(<span class="keywordtype">int</span> stage);
<a name="l00073"></a>00073 
<a name="l00081"></a><a class="code" href="a00030.html#a179c8bf9d4613cbb1af0a85d779827a6">00081</a>     <span class="keyword">const</span> <a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a>* <a class="code" href="a00030.html#a179c8bf9d4613cbb1af0a85d779827a6" title="Returns the playgroundSize.">getPgs</a>(){
<a name="l00082"></a>00082       initializeIfNecessary();
<a name="l00083"></a>00083         <span class="keywordflow">return</span> &amp;playgroundSize;
<a name="l00084"></a>00084     }
<a name="l00085"></a>00085 
<a name="l00087"></a><a class="code" href="a00030.html#a37a1abb90a220afdaf6dbdab58299e51">00087</a>     <span class="keywordtype">bool</span> <a class="code" href="a00030.html#a37a1abb90a220afdaf6dbdab58299e51" title="Returns true if our playground represents a torus (borders are connected)">useTorus</a>(){
<a name="l00088"></a>00088       initializeIfNecessary();
<a name="l00089"></a>00089       <span class="keywordflow">return</span> useTorusFlag;
<a name="l00090"></a>00090     }
<a name="l00091"></a>00091 
<a name="l00093"></a>00093     <span class="keyword">virtual</span> <a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a> getRandomPosition();
<a name="l00094"></a>00094 
<a name="l00096"></a><a class="code" href="a00030.html#a84c3d488e01d52be51c686e3fb206498">00096</a>     <span class="keywordtype">bool</span> use2D()
<a name="l00097"></a>00097     {
<a name="l00098"></a>00098       initializeIfNecessary();
<a name="l00099"></a>00099       <span class="keywordflow">return</span> use2DFlag;
<a name="l00100"></a>00100     }
<a name="l00101"></a>00101 
<a name="l00103"></a><a class="code" href="a00030.html#a1c955c6c60dfa5b46a2bf683a20a84fe">00103</a>     <span class="keywordtype">long</span> getUniqueAirFrameId()
<a name="l00104"></a>00104     {
<a name="l00105"></a>00105       initializeIfNecessary();
<a name="l00106"></a>00106 
<a name="l00107"></a>00107       <span class="comment">// if counter has done one complete cycle and will be set to a value it already had</span>
<a name="l00108"></a>00108       <span class="keywordflow">if</span> (airFrameId == -1) {
<a name="l00109"></a>00109         <span class="comment">// print a warning</span>
<a name="l00110"></a>00110         ev &lt;&lt; <span class="stringliteral">&quot;WARNING: AirFrameId-Counter has done one complete cycle.&quot;</span>
<a name="l00111"></a>00111         &lt;&lt; <span class="stringliteral">&quot; AirFrameIds are repeating now and may not be unique anymore.&quot;</span> &lt;&lt; endl;
<a name="l00112"></a>00112       }
<a name="l00113"></a>00113 
<a name="l00114"></a>00114       <span class="keywordflow">return</span> airFrameId++;
<a name="l00115"></a>00115     }
<a name="l00116"></a>00116  };
<a name="l00117"></a>00117 
<a name="l00118"></a>00118 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>BaseWorldUtility.h</b>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:29 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
